What's New in the JAWS 9.0 Scripting Language
Compared to JAWS 8.0

Analyzed by Jamal Mazrui (with a Ruby program)
On October 9, 2007

Contents
170 new functions
8 new scripts
2 dropped functions
4 dropped scripts
Documentation for 170 new functions
Documentation for 8 new scripts
----------

170 new functions

ActivateOnMouseOver
AddCustomNodes
AlphaNumCombinations
AlphaNumCombinationsHlp
BrailleAddFocusCell
BrailleOptionsHlp
CapsIndicate
CapsIndicateDuringSayAll
CapsIndicateDuringSayAllHlp
CapsIndicateHlp
CellChangedEvent
ConvertListToNodeList
CursorOptionsHlp
CustomLabelsSet
CustomLabelsSetHlp
DocumentPresentationSet
DocumentPresentationSetHlp
EditingOptionsHlp
FlashMoviesRecognize
FlashMoviesRecognizeHlp
FormsOptionsHlp
FrameLoadedEvent
GeneralOptionsHlp
GetCellNote
GetControlIDString
GetCursorPos
GetCursorPosString
GetCustomLabelFileName
GetCustomLabelSectionName
GetDayOfWeek
GetDefaultBrlDisplaySectionName
GetDefaultSynthGlobalSectionName
GetDocumentProperties
GetEmbeddedObjectDescription
GetIntOptionDefaultSetting
GetListOfProofreadingElements
GetProofreadingElementCount
GetProofreadingElementInfo
GetSelectionContext
GetSelectionContextFlags
GetWordInContext
Grade2OptionsHlp
GraphicsOptionsHlp
GraphicsShow
GraphicsShowHlp
HasVirtualEnhancedClipboard
HeadingAndFrameOptionsHlp
HJDialogObjStateChangeSpoken
IndentationIndicate
IndentationIndicateHlp
IsRTLLanguageProcessorLoaded
IsScriptingEditionAuthorized
IsWinVista
LanguageDetectChange
LanguageDetectChangeHlp
LinksOptionsHlp
ListAndTableOptionsHlp
lvGetGroupName
lvGetSelectionCount
lvMoveByLineUnit
MarkingOptionsHlp
MoveToProofreadingElement
MoveToProofreadingElementByIndex
NavigationQuickKeysSet
NavigationQuickKeysSetHlp
NodeHlp
OptionsTreeCore
PageRefresh
PageRefreshHlp
PanningOptionsHlp
ParseLongDate
ParseShortDate
PrependItemWithNode
ProgressBarSetAnnouncement
ProgressBarSetAnnouncementHlp
PunctuationSetLevel
PunctuationSetLevelHlp
ReadingOptionsHlp
RoutePcToInvisible
RunSelectionContextEvents
SayAllReadsBy
SayAllReadsByHlp
ScreenEchoSet
ScreenEchoSetHlp
ScreenSensitiveHelpForJAWSOptionsDialog
ScreenSensitiveHelpWinforms
SelectionContextChangedEvent
SetSelectionContextFlags
SmartWordReadingSet
SmartWordReadingSetHlp
smmGetDesiredUnitsOfMeasure
SpellingOptionsHlp
SpellModeSet
SpellModeSetHlp
StartMAGicSayAll
SynthesizerMute
SynthesizerMuteHlp
TableEnteredEvent
TableExitedEvent
TableOptionsHlp
TabStopEvent
TextOptionsHlp
TopAndBottomEdgeIndicate
TopAndBottomEdgeIndicateHlp
TreeCoreGetDefaultBrailleMarkingList
TreeCoreGetDefaultBrailleOptions
TreeCoreGetDefaultOptions
TreeCoreGetDefaultVCursorOptions
tvGetItemText
tvGetParent
tvGetSelection
TypingEchoSet
TypingEchoSetHlp
UnknownItemHlp
UseSapi5ForSayAll
vCursorAbbreviationsExpand
vCursorAbbreviationsExpandHlp
vCursorAccessKeysShow
vCursorAccessKeysShowHlp
vCursorAcronymsExpand
vCursorAcronymsExpandHlp
vCursorAttributesIndicate
vCursorAttributesIndicateHlp
vCursorBlockQuotesIdentifyStartAndEnd
vCursorBlockQuotesIdentifyStartAndEndHlp
vCursorButtonsShowUsing
vCursorButtonsShowUsingHlp
vCursorCustomPageSummaryy
vCursorCustomPageSummaryyHlp
vCursorFormFieldsIdentifyPromptUsing
vCursorFormFieldsIdentifyPromptUsingHlp
vCursorFormsModeAutoOff
vCursorFormsModeAutoOffHlp
vCursorFramesShowStartAndEnd
vCursorFramesShowStartAndEndHlp
vCursorGraphicalLinksSet
vCursorGraphicalLinksSetHlp
vCursorGraphicsSetRecognition
vCursorGraphicsSetRecognitionJlp
vCursorGraphicsShow
vCursorGraphicsShowHlp
vCursorHeadingsAnnounce
vCursorHeadingsAnnounceHlp
vCursorImageMapLinksShow
vCursorImageMapLinksShowHlp
vCursorInlineFramesShow
vCursorInlineFramesShowHlp
vCursorLayoutTables
vCursorLayoutTablesHlp
vCursorLinksIdentifySamePage
vCursorLinksIdentifySamePageHlp
vCursorLinksIdentifyType
vCursorLinksIdentifyTypeHlp
vCursorListsIdentifyStartAndEnd
vCursorListsIdentifyStartAndEndHlp
vCursorRepeadedTextSkip
vCursorRepeadedTextSkipHlp
vCursorScreenTrack
vCursorScreenTrackHlp
vCursorTablesShowStartAndEnd
vCursorTablesShowStartAndEndHlp
vCursorTableTitlesAnnounce
vCursorTableTitlesAnnounceHlp
vCursorTextLinksShow
vCursorTextLinksShowHlp
vCursorUntaggedGraphicalLinkShow
vCursorUntaggedGraphicalLinkShowHlp
VerbositySetLevel
VerbositySetLevelhlp
VirtualCursorOptionsHlp
----------

8 new scripts

AdjustBrailleOptions
AdjustJAWSOptions
NextDocumentWindowByPage
PreviousDocumentWindowByPage
RouteVirtualToPc
UtilityDumpEntireOSM
UtilityDumpScreenOSM
WheelsTracking
----------

2 dropped functions

MagSetFocus
RoutePCToInvisible
----------

4 dropped scripts

MagSayNextCharacter
MagSayNextLine
MagSayPriorCharacter
MagSayPriorLine
----------

Documentation for 170 new functions
----------

:function ActivateOnMouseOver
:Synopsis Activates OnMouseOver action at active cursor
:Description This function Activates the OnMouseOver action at the active cursor. It is used primarily for the virtual cursor. This function was introduced in JAWS 8.0 update1.
:Returns int TRUE if successful, FALSE otherwise.
:Category Mouse


:function AddCustomNodes
:Synopsis Used to add additional items to the main group in OptionsTreeCore.:Description This function can create a node for your custom items either with a name you specify or by using your coniguration name, such as MyApp Options, where MyApp is the name of your configuration.
:Description This function adds a node to each segment in the list you pass, which does not already contain a node path.  The node will either be the node option specified in the optional parametor, or "MyApp Options", where MyApp is the name of your configuration.
:Param string/byRef/sCustomItems The list of list item segments, delivered in the dlgSelect*ToRun format
:Optional
:Param string/strNewNode This optional Parameter is where you enter the node path to provide each list item.  Leave it blank to allow the function to provide the node based on your configuration's name.
:Category Strings


:function AlphaNumCombinations
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function AlphaNumCombinationsHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function BrailleAddFocusCell
:Description Used from within the BrailleAddObjectXX functions to Braille the contents of a table cell which may visually span multiple lines. This also allows proper tracking of the caret when editing the contents of a cell.
:Returns Int True if successful, false otherwise.
:Category Braille Output


:function BrailleOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function CapsIndicate
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function CapsIndicateDuringSayAll
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function CapsIndicateDuringSayAllHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function CapsIndicateHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function CellChangedEvent
:Description This event function is triggered when the cursor moves from one cell in a table to a new cell in either the same table or a nested table or parent table.
:Returns Void
:Param int/nNewCol
:Param int/nNewRow
:Param int/nNewNesting
:Param int/nNewRowColCount
:Param int/nPrevCol
:Param int/nPrevRow
:Param int/nPrevNesting
:Param int/nPrevRowColCount
:Category Screen Text


:function ConvertListToNodeList
:Synopsis Prepends alist of options with the same node path.
:Description When you need to add a whole group of options in the same branch of the tree view, use this function to give each option the same node path.  Pass the group in the standard list format using the vertical bar (|) symbol as the primary array delimitor, and the colon (:) symbol as the divider between the callback function and the display text.
:Param string/ByRef/strList The list of list item segments, delivered in the dlgSelect*ToRun format
:Param string/sNode The node path explicit to the list you specified in the first parameter.
:Category Strings


:function CursorOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function CustomLabelsSet
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function CustomLabelsSetHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function DocumentPresentationSet
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function DocumentPresentationSetHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function EditingOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function FlashMoviesRecognize
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function FlashMoviesRecognizeHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function FormsOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function FrameLoadedEvent
:Synopsis fired when a frame's contents are updated on a webpage.
:Description This function is fired when a web page loads content into a frame.
:Returns void
:Param handle/hDoc the handle to the parent document's window
:Param string/sFrameName the name of the frame being updated
:Param int/nFrameIndex The index of the frame being updated.
:Category HTML


:function GeneralOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function GetCellNote
:Synopsis When in a spreadsheet, gets the note for the cell.
:Returns string The note for the cell, or an empty string if there is no note.
:Category Tables


:function GetControlIDString
:Synopsis Like GetControlID, but for .Net controls
:Description Retrieves the ID string for a control on a .Net Windows Form. This string is actually the name of the variable used by the programmer to name the field so it may or may not be useful. GetControlID is not useful in .Net applications because numeric control IDs are automatically assigned by the runtime and are
:Returns String a control's ID String
:Param Handle This function provides information for the window that is identified by a window handle. Type the name of a variable or choose a script function that can provide a window handle.
:Category Window


:function GetCursorPos
:Description This gets the cursor position relative to the top of the page or sccreen.
:Returns int TRUE if the coordinates were obtained in the desired unit of measure, FALSE otherwise.
:Param Int Type the constant value that represents a cursor, type a variable name, or choose a script function. Cursor constants are: CURSOR_JAWS, CURSOR_PC, CURSOR_INVISIBLE, CURSOR_Braille. A script function such as GetActiveCursor also can provide the constant.
:Param int desired units of measure,  see hjconst.jsh smmUnitsOfMeasure constants.
:Param Int/nCol/ByRef set to x coordinate of caret in desired unit of measure (if supported).
:Param Int/nRow/ByRef set to y coordinate of caret in desired unit of measure (if supported).
:Category Cursors


:function GetCursorPosString
:Description This gets the appropriate string describing the cursor position relative to the top of the page or sccreen.
:Returns String
:Param Int Type the constant value that represents a cursor, type a variable name, or choose a script function. Cursor constants are: CURSOR_JAWS, CURSOR_PC, CURSOR_INVISIBLE, CURSOR_Braille. A script function such as GetActiveCursor also can provide the constant.
:Optional
:Param int desired units of measure,  see hjconst.jsh smmUnitsOfMeasure constants.
:Category Cursors


:function GetCustomLabelFileName
:Synopsis returns the custom label filename for the current document
:Description This allows scripts used in the process of creating a custom label to obtain the filename for the current document.
:Returns string the filename containing custom labels for this document.
:Category Misc


:function GetCustomLabelSectionName
:Synopsis returns the custom label section name for the current document
:Description This allows scripts used in the process of creating a custom label to obtain the section name for the current document. Typically the section name is just [CustomLabels] but in the case of MSWord, where the labels are stored in a file named after the attached template, the section name may also be [CustomLabels docname.doc] where docname.doc refers to the specific document. thus, MSWord may define template level and document level custom labels.
:Returns string the section name containing custom labels for this document.
:Category Misc


:function GetDayOfWeek
:Description Returns a localized string representing the day of the week given a date in the YYYY/MM/DD format.     The day can be either the long day format or the short day format.
:Returns String The day of the week
:Param String/strDate a date in the format YYYY/MM/DD
:Optional
:Param String/strDayType "L" or "S". Determines if the day of the week is returned as a short abbreviated day or a long day.  Defaults to a long day name.
:Param String/locale The LCID to be used for determining the language in which the day name should be returned.  Defaults to the system LCID.
:Category System


:function GetDefaultBrlDisplaySectionName
:Description Retrieves the section name used in default.jcf for the default braille display.
:Returns string The section name in the default.jcf file of the currently active braille display.
:Category Files


:function GetDefaultSynthGlobalSectionName
:Description retrieves the section name used in default.jcf for the default synthesizer.
:Returns string The section name in default.jcf of the default synthisizer.
:Category Files


:function GetDocumentProperties
:Synopsis Returns various document properties for an editable text document. At present this function is only valid for Lotus Notes 8. This function is available in JAWS 8.0 update 1 and higher.
:Returns Int 1 for success, 0 for failure
:Param string/title The title of the document
:Optional
:Param string/PageName The number (or letter) of the current page
:Param string/PageNumber The number of a page as it relates to all pages. For example, PageNumber would be the number "1" in the text "1 of 3"
:Param string/TotalPages The total number of pages in the document
:Param string/LineNumber The current line number within a document page
:Param string/CharacterPosition The index of a character on a line of text
:Param string/ColumnNumber The number of the current text column
:Param string/TotalColumns The total number of text columns
:Param string/SectionName The name of the current text section
:Category Object Model and MSAA


:function GetEmbeddedObjectDescription
:Description Used to get the description of an object embedded within another object. Usually, this applies to objects, such as links, which may be embedded within a text object. Presently, this function will only return success when focus is on a text object with a role of IA2_ROLE_PARAGRAPH. At this time, the only application implementing such objects is in Lotus Notes 8. This function is available after JAWS 8, update 1.
:Returns string Description of the embedded object at the cursor position.
:Category Object Model And MSAA


:function GetIntOptionDefaultSetting
:Synopsis retrieves the shipping default settings for a JCF option.
:Description Looks in the shared settings directory for the default shipping value of a JCF option. If the application has a JCF file and the option is set there, retrieves the value for the setting; otherwise, retrieves the value from the default.jcf file.
:Returns int The default value of the setting in the shipping scripts; otherwise, -1 if the setting could not be retrieved.
:Param string The section name to which the JCF setting belongs.
:Param string The key name exactly as it appears in the JCF file.
:Category Files


:function GetListOfProofreadingElements
:Synopsis gets a delimited list of proofreading elements
:Description This function is used to obtain a delimited list of proofreading elements to present to the user so that the user can select and move the cursor to a particular element.
:Returns string the list of elements found delimitted by the specified delimiter or \007 if none specified.
:Param int/nProofreadingElementType see hjconst.jsh for the proofreading element types, peSpellingError, peGrammaticalError, peRevision
:Optional
:Param string/sDelim the delimiter to use to separate the elements.
:Category Object Model and MSAA


:function GetProofreadingElementCount
:Synopsis gets the number of spelling errors, grammatical errors or revisions in the current document
:Description This function returns the number of spelling errors, grammatical errors or revisions in the current document.
:Returns int the number of proofreading elements of the specified type.
:Param int/nProofreadingElementType see hjconst.jsh for the proofreading element types, peSpellingError, peGrammaticalError, peRevision
:Category Object Model and MSAA


:function GetProofreadingElementInfo
:Synopsis Gets information about a proofreading element at the current cursor location
:Description This function allows the scripter to obtain information about an element at the cursor such as the text, author, initials, type and date of the element (if relevant). Not all components are returned for all element types.
:Returns int TRUE if info was obtained for the specified element type, FALSE otherwise
:Param int/nProofreadingElementType see HJConst.jsh for types, prefixed by pe.
:Param string/byRef/sText text of element
:Param string/byRef/sAuthor author's name
:Param string/byref/sInitials Author's initials
:Param string/byref/sDesc extra descriptive information (such as revision type if element is a revision).
:Param string/byref/date date of element creation (such as revision or comment date).
:Category Object Model and MSAA


:function GetSelectionContext
:Synopsis Returns a bit pattern of flags indicating items present at the caret or within the current selection.
:Description This function returns the currently detected items at the caret or in the selection as determined by the flags set in SetSelectionContextFlags. For instance, if selCtxSpellingErrors is set, and there is a spelling error at the caret location, this flag will be set in the result returned by this function.
:Returns int a bit pattern of the detected items at the caret or within the selection.
:Category Speech Markup


:function GetSelectionContextFlags
:Synopsis Returns the flags set by SetSelectionContextFlags which will determine which items will be detected during document navigation.
:Description This function enables the user to determine which flags are currently set and thus which items will be detected during document navigation.
:Returns int The flags set by SetSelectionContextFlags.
:Category Speech Markup


:function GetWordInContext
:Description When in a spell check, find, or replace dialog, this function gets the line of text from within a document that contains the active word in the dialog. Used, for example, to speak the context of a particular word which the spell check dialog thinks is misspelled.
:Returns String Provides a line of text containing the word in question.
:Category Screen Text


:function Grade2OptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function GraphicsOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function GraphicsShow
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function GraphicsShowHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function HasVirtualEnhancedClipboard
:Description True by default, overwrite this function to return false for apps where the enhanced clipboard features are not available when the virtual cursor is active.
:Returns int True if the enhanced clipboard features are available when the virtual cursor is active, false otherwise.
:Category HTML


:function HeadingAndFrameOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function HJDialogObjStateChangeSpoken
:Description called by ObjStateChangedEvent to perform any special processing of object state change occuring in an HJDialog.
:Returns int true if any special handling of state change was processed for an HJDialog, false otherwise.
:Param Handle/hObj Handle of the window whose state, or whose child object's state, has changed.
:Param int/iObjType The type of the object.
:Param int/nChangedState The changed state, which is the difference between the old state and the current state.
:Param int/nState The current state.
:Param int/nOldState The old state.
:Category Object Model and MSAA


:function IndentationIndicate
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function IndentationIndicateHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function IsRTLLanguageProcessorLoaded
:Description Used to detect if a Right to Left aware language processor is loaded.
:Returns Int True if RTL language processor is loaded, false otherwise.
:Category Misc


:function IsScriptingEditionAuthorized
:Description Determines whether or not the Script Edition option is enabled.
:Returns Int TRUE if the Scripting Edition option is enabled, FALSE otherwise.
:Category FS Product Info


:function IsWinVista
:Synopsis Determines if the current operating system is Windows Vista.
:Description This function returns true if the OS in use is Windows Vista.
:Returns Int true or false.
:Category System


:function LanguageDetectChange
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function LanguageDetectChangeHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function LinksOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function ListAndTableOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function lvGetGroupName
:Description Retrieves the name of the grouping that contains an item in a listview.
:Returns String The name of the group
:Param Handle to the window containing a ListView.
:Param Int 1-based index of the item in the ListView of interest.
:Category Dialog Controls


:function lvGetSelectionCount
:Description Retrieves a count of the selected items in a ListView.
:Returns Int the count of selected items.
:Category Dialog Controls


:function lvMoveByLineUnit
:Synopsis Performs navigation in a listview where NextLine or PriorLine etc do not perform as desired.
:Description Use with listview controls which may be manipulated with the lv functions but which need special scripting for navigation.
:Returns int true if the move was successful, false otherwise.
:Param int One of the lvLineMoveUnit constants defined in HJConst.jsh-- lvLineMoveUnitFirst, lvLineMoveUnitLast, lvLineMoveUnitPrior or lvLineMoveUnitNext.
:Optional
:Param int bMayWrap True if requests to move to prior or next line may wrap past the beginning or end of the list.
:Category Dialog Controls


:function MarkingOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function MoveToProofreadingElement
:Synopsis moves the cursor to the first, next, previous or last proofreading element in the document.
:Description This function moves the cursor to the first, next, previous or last proofreading element in the document.
:Returns int TRUE for success, FALSE otherwise.
:Param int/nProofreadingElementType see hjconst.jsh for the proofreading element types, peSpellingError, peGrammaticalError, peRevision
:Param int/nSearchTypeFlags, see hjconst.jsh, s_top, s_bottom, s_next, s_prior
:Param string/byref/sElementFound on success, is filled with the text of the element found
:Category Object Model and MSAA


:function MoveToProofreadingElementByIndex
:Synopsis moves to a proofreading element by its 1-based index
:Description This function is used in conjunction with GetListOfProofreadingElements to move the cursor to the selected element from the list via its index.
:Returns int TRUE if the move was successful, FALSE otherwise.
:Param int/nProofreadingElementType see hjconst.jsh for the proofreading element types, peSpellingError, peGrammaticalError, peRevision
:Param int/nIndex 1-based index
:Param string/byref/sElementFound on success, is filled with the text of the element found
:Category Object Model and MSAA


:function NavigationQuickKeysSet
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function NavigationQuickKeysSetHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function NodeHlp
:Description Calls the appropriate Node hlp callack function, based upon the string node parameter.  This is where dlgSelectTreeFuntionToRun gets the help strings.  In so doing, localizers of Freedom Scientific products can translate the text of the node name into any language, and still the correct hlp callback function is called.  In your own scripts, overwrite this function for your own nodes based upon the parameter, and write your corresponding hlp Callback function.  See UserOptions.jss for definition of function and structure.
:Returns string The human-readable string name of the new setting.
:Category Help


:function OptionsTreeCore
:Synopsis Creates formatted string and presents the "Adjust JAWS Options" dialog box.
:Description This function is equivalent to VerbosityCore, except that it formats the string for and presents the "Adjust JAWS Options" (Insert+v) dialog box.
:Param string/sCustomItems List of items, wherein the list is segmented using the vertical bar (|) symbol.  Each segment is divided with the colon (:) symbol, where segment 1 is the callback function name and segment 2 is the display text, which may or may not contain a node path.  You must have a callback function and a corresponding hlp callback function with the same name as segment 1 of each array slice.  See UserOptions.jss and accompanying files for string and function format.
:Optional
:Param int/iRetNodeSettings Enter TRue for this optional parameter, if you do not want this function to update item strings which do not have node paths. If you ignore or leave this parameter FALSe, your items will be formatted with the node you specify in the strNewNode parameter.  Ignoring these parameters is the fastest way to get your items in in their own group.
:Param string/strNewNode Enter the explicit path in which to place all items in your list which do not have nodes.
:Category Scripts


:function PageRefresh
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function PageRefreshHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function PanningOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function ParseLongDate
:Description Formats a locale-specific date string in a long date format into a string in the standard form YYYY/MM/DD.
:Returns String The formatted date.
:Param String/strDate a date string  in a Locale specific format
:Optional
:Param String/locale The LCID representing the format of strDate. Defaults to the system LCID.
:Category System


:function ParseShortDate
:Description Formats a locale-specific date string in a short date format into a string in   the standard form YYYY/MM/DD.
:Returns String The formatted date.
:Param String/strDate a short date string  in a Locale specific format
:Optional
:Param String/strYear A year to be added to the shortDateString.  If not provided then the shortDateString is assumed to be fully qualified
:Param String/locale The LCID representing the format of strDate.  Defaults to the system LCID.
:Category System


:function PrependItemWithNode
:Synopsis Adds node or tree branch path to traditional listitem.
:Description Prepares list item string segment to be used in an array passed to the dlgSelectTreeFunctionToRun function.
:Returns string the modified string segment with the path string.
:Param string/strItem This is the string segment which contains the function callback, a colon, and the list item display text.
:Param string/strNode This is the branch, or path of branches.  Note that it should not end with the node path separator.  Examples of nodes would be "General Options" or "Reading Options.Sayall Options" (note noperiod at end of example; this is added by the function.)
:Category Strings


:function ProgressBarSetAnnouncement
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function ProgressBarSetAnnouncementHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function PunctuationSetLevel
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function PunctuationSetLevelHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function ReadingOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function RoutePcToInvisible
:Description This attempts to move the PC cursor to the position of the Invisible cursor.  This function is the same as a single click of the left mouse button at the position of the invisible cursor, which instructs Windows to move its insertion point to the position of the mouse pointer.  The successful use of this function is related to the Windows operating system. There are often situations where Windows cannot move the PC cursor to the mouse pointer.
:Category Cursors


:function RunSelectionContextEvents
:Synopsis enables the scripter to force the selection context events to be rerun
:Description This function may be called from SayFocusedWindow or other places when it is necessary for the Selection Context Events to be rerun
:Returns void
:Category Object Model and MSAA


:function SayAllReadsBy
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function SayAllReadsByHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function ScreenEchoSet
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function ScreenEchoSetHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function ScreenSensitiveHelpForJAWSOptionsDialog
:Synopsis Provides screen sensitive help for the JAWS Options dialog.
:Returns Void
:Category Help


:function ScreenSensitiveHelpWinforms
:Synopsis Help for controls in the Winforms (.Net) Windows.
:Description Help for embedded controls in .Net applications and/or controls.  Add your code to this function to support additional controls.
:Category Help


:function SelectionContextChangedEvent
:Description This event function is triggered when any of the enabled selection context data flags changes as one navigates in supported applications. Where extra contextual information is required to report the change in context, relevant flags and strings are filled in with data. For example, navigating into a formfield, nData1 will be the type(see WT_CONSTANTS), nData2 will be the state, sDesc1 the prompt, sDesc2 the value, sDesc3 the positional information and sDesc4 the extra help information if available. For comments, sDesc1 is the author's name, sDesc2 the initials, sDesc3 the text of the actual comment. For footnotes or endnotes, sDesc1 is the reference id and sDesc2 the text of the note. For bookmarks and smart tags, sDesc1 is the name of the item. For revisions, nData1 is the type of revision, sDesc1 the author, sDesc2 the initials and sDesc3 the text. For shapes or objects, nData1 is a type specifier, nData2 a builtin shape type, sDesc1 the name of the object, sDesc2 the text, and sDesc3 the dimentions. The units of measure used for the dimentions are in the current desired units of measure as defined by the smmSetDesiredUnitsOfMeasure function. For selCtxPageSectionColumnBreaks, nData1=column number, nData2=number of text columns sDesc1=page n, sDesc2=sectiony , sDesc3=z text columns (text column count) sDesc4= column j (where j is the number of the text column) For other contextual information such as spelling and grammar, the relevant bit of the context flags will be set in the new and cleared in the old to indicate moving into an error, or vice versa when exiting. Table info should be gathered from the table specific events. See hjconsnt.jsh for the selCtx constant bit values.
:Returns Void
:Param int/nSelectionContextFlags
:Param int/nPrevSelectionContextFlags
:Param int/nData1
:Param int/nData2
:Param string/sDesc1
:Param string/sDesc2
:Param string/sDesc3
:Param string/sDesc4
:Param string/sDesc5
:Category Screen Text


:function SetSelectionContextFlags
:Synopsis Enables the user to determine which contextual information to indicate when navigating.
:Description This function enables the user to choose which selection context information to indicate when navigating (in documents supporting this feature). See the selCtx* constants in hjconst.jsh for a list of the flags which may be enabled. Note that the behaviour of the indication if enabled is controlled via the Speech and Sounds Scheme in effect., however this function enables the flags to be toggled on the fly independent of scheme behavior.
:Returns int TRUE if successful, FALSE otherwise.
:Param int/nFlags The flags ored together.
:Category Speech Markup


:function SmartWordReadingSet
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function SmartWordReadingSetHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function smmGetDesiredUnitsOfMeasure
:Synopsis Gets the units of measure used for reporting indentation and other measurements.
:Description This function is used to get the units of measure JAWS uses for speaking measurements such as indentation etc.
:Returns int the unit of measure currently set in the Speech Markup Engine (see smmSetDesiredUnitsOfMeasure), one of smmPixels, smmSpaces, smmPoints, smmMM, smmCM or smmInches.
:Category Speech Markup


:function SpellingOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function SpellModeSet
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function SpellModeSetHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function StartMAGicSayAll
:Synopsis Notifies JAWS that MAGic is starting a SayAll
:Description This function sets IsSayAllInProgress to TRUE. This function was introduced in JAWS 8.0 update1.
:Returns int TRUE if successful, FALSE otherwise.
:Param Int/bUseSayAllSynthesizer This parameter may be used to indicate whether or not the Say All speech synthesizer should be used.  The default value of this parameter if FALSE which causes JAWS to use the primary speech synthesizer for the Say All operation.
:Category Screen Text


:function SynthesizerMute
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function SynthesizerMuteHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function TableEnteredEvent
:Description This event function is triggered when the cursor moves into a table from outside a table. When this event is fired, query for any relevant Braille info for cell text or row text etc if Braille in use and then use this in the BrailleAddObjectXX table functions in the scripts.
:Returns Void
:Param int/nTblCols
:Param Int/nTblRows
:Param Int/nTblNesting
:Param Int/nCurCol
:Param Int/nCurRow
:Param Int/bUniform
:Param int/bHasMarkedHeaders TRUE if titles are defined for this table, FALSE if none explicitly defined
:Param int/nHeadersColumn The column number of the column containing row headers (0 if undefined).
:Param int/nHeadersRow The row number of the row containing column headers (0 if undefined).
:Category Screen Text


:function TableExitedEvent
:Description This event function is triggered when the cursor leaves a table and returns to the surrounding document.
:Returns Void
:Category Screen Text


:function TableOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function TabStopEvent
:Description This function gets called in supported apps when the tab key causes the position of the caret to change (ie to move to the next tab stop). It is to be used to automatically announce the new caret position. Currently this is only enabled in MSWord.
:Returns Void
:Param string/sNewPos
:Category Screen Text


:function TextOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help


:function TopAndBottomEdgeIndicate
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function TopAndBottomEdgeIndicateHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function TreeCoreGetDefaultBrailleMarkingList
:Synopsis Returns the Braille Marking options for the JAWS tree view.
:Description Returns the list of options for marking with dots 7 and 8 on the Braille display.  This string is fopmatted for the JAWs tree view.
:Returns String the list of options.
:Category Scripts


:function TreeCoreGetDefaultBrailleOptions
:Synopsis Returns the list of the default Braille Options.
:Description returns all the default Braille options with their complete node paths.  These arethe options for your Braille display.
:Returns String the list of options.
:Optional
:Param int True if the root node is to be discarded when building the branch to display, false otherwise. Default is false.
:Category Scripts


:function TreeCoreGetDefaultOptions
:Synopsis Default options for AdustJawsOptions dialog box.
:Description This function returns the string list of all the default options with node paths for the AdjustOptions dialog.
:Returns String the list of options.
:Category Scripts


:function TreeCoreGetDefaultVCursorOptions
:Synopsis This function returns the list of the default options for thh Virtual Cursor
:Description This function returns the list of options for the Virtual Cursor, formerly html options.
:Returns String the list of options.
:Category Scripts


:function tvGetItemText
:Description Returns a string for a specific tree item.
:Returns String The HTREEITEM text.
:Param Handle The TreeView window.
:Param int/nTreeItem Integer representing a specific HTREEITEM.
:Category Dialog Controls


:function tvGetParent
:Description Returns an integer, representing the HTREEITEM, for the parent of a specific tree item.
:Returns int The parent HTREEITEM.
:Param Handle The TreeView window.
:Param int/nTreeItem Integer representing a specific HTREEITEM.
:Category Dialog Controls


:function tvGetSelection
:Description Returns an integer, representing the HTREEITEM, for the current selected item.
:Returns int The selected HTREEITEM.
:Param Handle The TreeView window.
:Category Dialog Controls


:function TypingEchoSet
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function TypingEchoSetHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function UnknownItemHlp
:Synopsis Help callback function for those tree items without help callbacks
:Description Do not call this function; it is used by the tree view in the JAWS dialogs, specifically by components of dlgSelectTreeFunctionToRun.
:Returns string The help text.
:Optional
:Param int/iRetCurVal May be used internally if option is executed.
:Category Help


:function UseSapi5ForSayAll
:Synopsis Returns TRUE if SAPI 5 should be used for Say All.
:Description This function returns TRUE if SAPI 5 should be used for Say All and returns FALSE otherwise.
:Returns Int TRUE if SAPI 5 should be used for Say All.  FALSE otherwise.
:Category Voices


:function vCursorAbbreviationsExpand
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorAbbreviationsExpandHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorAccessKeysShow
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorAccessKeysShowHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorAcronymsExpand
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorAcronymsExpandHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorAttributesIndicate
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorAttributesIndicateHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorBlockQuotesIdentifyStartAndEnd
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorBlockQuotesIdentifyStartAndEndHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorButtonsShowUsing
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorButtonsShowUsingHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorCustomPageSummaryy
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorCustomPageSummaryyHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorFormFieldsIdentifyPromptUsing
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorFormFieldsIdentifyPromptUsingHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorFormsModeAutoOff
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorFormsModeAutoOffHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorFramesShowStartAndEnd
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorFramesShowStartAndEndHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorGraphicalLinksSet
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorGraphicalLinksSetHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorGraphicsSetRecognition
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorGraphicsSetRecognitionJlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorGraphicsShow
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorGraphicsShowHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorHeadingsAnnounce
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorHeadingsAnnounceHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorImageMapLinksShow
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorImageMapLinksShowHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorInlineFramesShow
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorInlineFramesShowHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorLayoutTables
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorLayoutTablesHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorLinksIdentifySamePage
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorLinksIdentifySamePageHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorLinksIdentifyType
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorLinksIdentifyTypeHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorListsIdentifyStartAndEnd
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorListsIdentifyStartAndEndHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorRepeadedTextSkip
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorRepeadedTextSkipHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorScreenTrack
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorScreenTrackHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorTablesShowStartAndEnd
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorTablesShowStartAndEndHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorTableTitlesAnnounce
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorTableTitlesAnnounceHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorTextLinksShow
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorTextLinksShowHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function vCursorUntaggedGraphicalLinkShow
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function vCursorUntaggedGraphicalLinkShowHlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function VerbositySetLevel
:Description Callback function for tge dlgSelectTreeFunctionToRun function.  The int parameter is set to TRUE when the tree is refreshed, FALSE if the corresponding option was executed.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value set by the internal dlgSelectTreeFunctionToRun function.  0 = change setting, 1 = raetain current setting.
:Category Settings


:function VerbositySetLevelhlp
:Description Help callback function which provides help for the selected setting and item in the tree view inspired by the dlgSelectTreeFunctionToRun internal function.
:Returns string The human-readable string name of the new setting.
:Param int/iRetCurVal The value which may be set by the internal dlgSelectTreeFunctionToRun function.
:Category Help


:function VirtualCursorOptionsHlp
:Description This help callback function relates to a node, or group of options.  When this node is selected, this function is called by dlgSelectTreeFunctionToRun.  Hlp callback functions for nodes are named after the display text of that node with spaces removed and the suffix hlp appended.
:Returns string The human-readable string name of the new setting.
:Category Help
----------

Documentation for 8 new scripts
----------

:script AdjustBrailleOptions
:Synopsis Braille Options dialog, which replaces SetBrailleVerbosity dialog.
:Description This tree view contains all the options available in the Braille group of the Adjust JAWS Options dialog.
:Category scripts


:script AdjustJAWSOptions
:Synopsis Provides a dialog with common options to be adjusted in JAWS.
:Description This dialog shows many common options using a tree view, where they are ordered by category in a manner more easily understood.
:Category scripts


:script NextDocumentWindowByPage
:Synopsis Passes the keystroke ctrl page down to the application. Do not change this assignment.
:Description This is a keystroke recommended by Microsoft for changing dialog pages.


:script PreviousDocumentWindowByPage
:Synopsis Passes the keystroke ctrl page up to the application.  Do not change this assignment.
:Description This is a keystroke recommended by Microsoft for changing dialog pages.


:script RouteVirtualToPc
:Synopsis Route Virtual Cursor to PC Cursor.
:Description Routes the Virtual Cursor to the location of the PC cursor or focus.  The Virtual Cursor is the reading cursor you use for web pages and other documents such as aAobe PDF.
:Category Cursors


:script UtilityDumpEntireOSM
:Synopsis Dump entire offscreen database
:Description Used by developers to dump, not refresh, the entire offscreen database, which is reconstructed based on internal timers.
:Category Test


:script UtilityDumpScreenOSM
:Synopsis Dump OSM offscreen databsse.
:Description Dump database related to the screen area.  This is not a refresh and is used by developers.
:Category System


:script WheelsTracking
:Synopsis Track focus in clasiic fashion, or track the Braille Cursor.
:Description Press this keystroke to toggle between the two settings.  This temporary setting allows you to track focus, using line/sentence/paragraph and dialog navigation, or track the Braille Cursor.  When tracking the Braille Cursor, the left wheel moves by lines, while the right wheel moves left and right.  Since the right wheel does not wrap, you can realistically visualize the layout of your screen.
:Category Braille Output

----------
End of Document
